Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use default profile and switch country-specific profiles into a feature flag #39

Merged
merged 114 commits into from
Aug 15, 2024
Merged

Use default profile and switch country-specific profiles into a feature flag #39

merged 114 commits into from
Aug 15, 2024

Conversation

melbeltagy
Copy link
Contributor

@melbeltagy melbeltagy commented Jul 30, 2024 •
edited
Loading

Changes:

  • Splitting each module's code into org.niis.* and fi.dvv.* packages for common and Finland-specific features respectively.
  • Switch application.properties into yaml format for:
    • Clarity in properties structure
    • Better support with docker/k8s based environments and usage.
  • Switching from fi profile to the new xroad-catalog.country.fi.enabled feature flag for both collector and lister modules
  • Loading Finland-specific features based on the new xroad-catalog.country.fi.enabled feature flag.
  • Using application.yaml as a common/base configuration file with all default configurations
  • Using dev profile configuration for local development (to run service from IDE)
  • Using test profile configuration for tests only
  • Removing sshtest profile but keeping/updating the documentation
  • Adding application-fi.sample.yaml and application-production.sample.yaml sample profiles
  • Using persistence module only for entities and repositories by:
    • Splitting services from persistence module into either collector or lister modules
    • Persistence module no longer can run as an application
    • Persistence module no longer can be used to apply database changes as liquibase is already configured
  • Grouping properties into different logical groups
  • Removing unused properties
  • Adding new configuration section in each module's README.md with all configurations related to the the module

Refs: XRDCAT-8

@melbeltagy
refactor: Move common entities to org.niis...entity package
5026ee6 
Refs: XRDCAT-8
@melbeltagy
refactor: Move common repositories to org.niis...repository package
7a3489f 
Refs: XRDCAT-8
@melbeltagy
refactor: Move DTOs from persistence module to lister module (splitti…
3ba25f1 
…ng into common/fi packages)

Refs: XRDCAT-8
@melbeltagy
refactor: Move services from persistence module to collector module (…
053eb3d 
…splitting into common/fi packages)

Refs: XRDCAT-8
@melbeltagy
refactor: Move lister's controllers into own (common/fi) controller p…
0c8af98 
…ackage

Refs: XRDCAT-8
@melbeltagy
refactor: Move lister's endpoints into own (common/fi) endpoint package
76b8e45 
Refs: XRDCAT-8
@melbeltagy
refactor: Move lister's services into own (common/fi) service package
b867bf1 
Refs: XRDCAT-8
@melbeltagy
refactor: Move lister's converters into own (common/fi) converter pac…
7fbb455 
…kage

Refs: XRDCAT-8
@melbeltagy
refactor: Move lister's interceptors into own common interceptor package
63cabbe 
Refs: XRDCAT-8
@melbeltagy
refactor: Move lister's configurations into own common configuration …
23c1bea 
…package

Refs: XRDCAT-8
@melbeltagy
refactor: Move lister's exception into own common exception package
dbc526e 
Refs: XRDCAT-8
@melbeltagy
refactor: Split CatalogService into two (one for each lister/collecto…
e0b8483 
…r service) based on usage

Refs: XRDCAT-8
@melbeltagy
refactor: Split CompanyService into two (one for each lister/collecto…
94c1b99 
…r service) based on usage

Refs: XRDCAT-8
@melbeltagy
refactor: Split OrganizationService into two (one for each lister/col…
0acc838 
…lector service) based on usage

Refs: XRDCAT-8
@melbeltagy
fix: Fix imports after refactorings
bd1b146 
Refs: XRDCAT-8
@melbeltagy
refactor: Move repositories' tests into corresponding (common/fi) ser…
e741346 
…vice package

Refs: XRDCAT-8
@melbeltagy
refactor: Remove persistence' Application class and keep it for tests…
7c65983 
… only

Refs: XRDCAT-8
@melbeltagy
fix: Add/fix tests initialization by scanning required packages
39b7b46 
Refs: XRDCAT-8
@melbeltagy
chore: Cleanup/remove unused code and SQL files from persistence's tests
8a185f0 
Refs: XRDCAT-8
@melbeltagy
refactor: Split collector's classes into default/vrk packages, add ap…
0d8657d 
…plication configs to scan components in both packages

Refs: XRDCAT-8
@melbeltagy
refactor: Split collector's tests into default/vrk packages, fix newl…
509a59b 
…y broken ones, add application.properties

Refs: XRDCAT-8
@melbeltagy
refactor: Move main classes to org.niis package
e131ce8 
Refs: XRDCAT-8
@melbeltagy
chore: Remove redundant dependencies
4c96cd5 
Refs: XRDCAT-8
@melbeltagy
refactor: switch to application.properties
df32580 
Refs: XRDCAT-8
@melbeltagy
fix: Fix license
b22ae48 
Refs: XRDCAT-8
@github-actions GitHub Actions
Copy link

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
x-road-catalog build test 8.7 ❌ Build Scan not published

petkivim
petkivim reviewed Aug 9, 2024
View reviewed changes
BUILD.md Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
x-road-catalog build test 8.7 ✅ Build Scan not published

@github-actions GitHub Actions
Copy link

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
x-road-catalog build test 8.7 ✅ Build Scan not published

@github-actions GitHub Actions
Copy link

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
x-road-catalog build test 8.7 ✅ Build Scan not published

raits
raits requested changes Aug 14, 2024
View reviewed changes
Copy link
Contributor

@raits raits left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few more small things I noticed, but looking pretty good otherwise.

BUILD.md Outdated Show resolved Hide resolved
doc/xroad_catalog_installation_guide.md Show resolved Hide resolved
doc/xroad_catalog_installation_guide.md Outdated Show resolved Hide resolved
xroad-catalog-collector/README.md Outdated Show resolved Hide resolved
xroad-catalog-collector/README.md Outdated Show resolved Hide resolved
xroad-catalog-lister/README.md Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
x-road-catalog build test 8.7 ✅ Build Scan not published

@melbeltagy
Copy link
Contributor Author

@raits , the configurations section in both READMEs for collector and lister services are updated as per your comments (moving reasonably defaulted values to proper optional sections).

And the configurations section in the installation guide is now updated by:

  • Splitting collector from lister service
  • Reference READMEs configurations sections (instead of repeating the configurations parameters list)
  • Added specific instructions for how to enable Finland-specific features (in both services)

And also, added ToC for READMEs and installation guide to help clarifying how the documents are structured

raits
raits approved these changes Aug 15, 2024
View reviewed changes
Copy link
Contributor

@raits raits left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, just a minor comment about the list styles for the new ToC-s.

xroad-catalog-collector/README.md Outdated Show resolved Hide resolved
xroad-catalog-lister/README.md Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
x-road-catalog build test 8.7 ✅ Build Scan not published

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Aug 15, 2024

Quality Gate Passed Quality Gate passed

Issues
31 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
1.8% Duplication on New Code

See analysis details on SonarCloud

@github-actions GitHub Actions
Copy link

Job Summary for Gradle

X-Road-Catalog tests :: BuildAndTest
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
x-road-catalog build test 8.7 ✅ Build Scan not published

@melbeltagy melbeltagy merged commit 86ad5bf into develop Aug 15, 2024
3 checks passed
@melbeltagy melbeltagy deleted the XRDCAT-8-clearer-profiles branch August 15, 2024 09:32
@melbeltagy melbeltagy restored the XRDCAT-8-clearer-profiles branch August 15, 2024 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@raits raits raits approved these changes

@petkivim petkivim Awaiting requested review from petkivim

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@melbeltagy @petkivim @raits